Package com.cisco.pt.ipc.sim
Interface ScriptModule
- All Superinterfaces:
CepInstance,IPCObject
- All Known Implementing Classes:
ScriptModuleImpl
Information provided by the PKI file:
\class CScriptModule
\brief CScriptModule access from itself.
\example ipcManager().thisInstance()
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptiongetInterface(String id) Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:getScriptCode(String id) Information provided by the PKI file:booleanhasInterface(String id) Information provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanshouldPromptExternalServerOperation(String protocol, int port) Information provided by the PKI file:booleanstop()Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.system.CepInstance
addExclusivePublisher, clearExclusivePublishers, getCep, getCommandLineArg, getExclusivePublisherAt, getExclusivePublisherCount, getInstanceId, hasExclusivePublisher, removeExclusivePublisher, removeExclusivePublisherAtMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
stop
boolean stop()Information provided by the PKI file:
\brief Stop Script Module \return bool, true if it has been stopped and false if otherwise- Returns:
- boolean Returns a boolean
-
getScriptCode
Information provided by the PKI file:
\brief Get Script Code based on script id \param id, script id \return QString, Script code- Parameters:
id- Takes in a parameter of id- Returns:
- String Returns a String
-
getScript
Information provided by the PKI file:
\brief Get Script Code based on script id and processes translations on the code, if exists. \param id, script id \return QString, processed Script code- Parameters:
id- Takes in a parameter of id- Returns:
- String Returns a String
-
hasScript
Information provided by the PKI file:
\brief Check if the script exists using script id \param id, script id \return bool, true if it exists and false otherwise- Parameters:
id- Takes in a parameter of id- Returns:
- boolean Returns a boolean
-
getInterfaceCode
Information provided by the PKI file:
\brief Get Interface Code based on Interface id.. \param id, Interface id \return QString, Interface code- Parameters:
id- Takes in a parameter of id- Returns:
- String Returns a String
-
getInterface
Information provided by the PKI file:
\brief Get Interface Code based on Interface id and processes translations on the code, if exists. \param id, Interface id \return QString, processed Interface code- Parameters:
id- Takes in a parameter of id- Returns:
- String Returns a String
-
hasInterface
Information provided by the PKI file:
\brief Check if the Interface exists using Interface id \param id, Interface id \return bool, true if it exists and false otherwise- Parameters:
id- Takes in a parameter of id- Returns:
- boolean Returns a boolean
-
getScriptDataStore
- Parameters:
id- Takes in a parameter of id- Returns:
- String Returns a String
-
shouldPromptExternalNetworkAccess
boolean shouldPromptExternalNetworkAccess()Information provided by the PKI file:
\brief This delegate determines if script module should prompt for external network access. \return bool, true if script module should prompt, otherwise false.- Returns:
- boolean Returns a boolean
-
shouldPromptExternalServerOperation
Information provided by the PKI file:
\brief This delegate determines if script module should prompt for external server operation. \param protocol, HTTP or TCP \param port, the port to listen on \return bool, true if script module should prompt, otherwise false.- Parameters:
protocol- Takes in a parameter of protocolport- Takes in a parameter of port- Returns:
- boolean Returns a boolean
-